package com.cr4y0n.crayonpicturebackend.service;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.cr4y0n.crayonpicturebackend.model.dto.user.UserQueryRequest;
import com.cr4y0n.crayonpicturebackend.model.entity.User;
import com.baomidou.mybatisplus.extension.service.IService;
import com.cr4y0n.crayonpicturebackend.model.vo.LoginUserVO;
import com.cr4y0n.crayonpicturebackend.model.vo.UserVO;

import javax.servlet.http.HttpServletRequest;
import java.util.List;

/**
 * 针对表【user(用户)】的数据库操作Service
 *
 * @author cr4y0n
 * @version 1.0.0
 */
public interface UserService extends IService<User> {

    /**
     * 用户注册服务
     *
     * @param userAccount   用户账号
     * @param userPassword  用户密码
     * @param checkPassword 校验密码
     * @return 返回新用户id
     */
    long userRegister(String userAccount, String userPassword, String checkPassword);

    /**
     * 用户登录服务
     *
     * @param userAccount  用户账号
     * @param userPassword 用户密码
     * @param request      请求
     * @return 返回登录用户id
     */
    LoginUserVO userLogin(String userAccount, String userPassword, HttpServletRequest request);

    /**
     * 获得脱敏后的登录用户信息
     *
     * @param user 用户信息
     * @return 用户信息（已脱敏）
     */
    LoginUserVO getLoginUserVO(User user);

    /**
     * 获取当前的登录用户
     *
     * @param request HTTP请求
     * @return 用户信息
     */
    User getLoginUser(HttpServletRequest request);

    /**
     * 加密用户密码
     *
     * @param userPassword 用户密码
     * @return 用户密码进行加密后的密文
     */
    String getEncryptedPassword(String userPassword);

    /**
     * 用户退出登录
     *
     * @param request HTTP请求
     * @return 用户信息
     */
    boolean userLogout(HttpServletRequest request);

    /**
     * 获得脱敏后的用户信息
     *
     * @param user 用户信息
     * @return 用户信息（已脱敏）
     */
    UserVO getUserVO(User user);

    /**
     * 获得脱敏后的用户信息列表
     *
     * @param userList 用户信息列表
     * @return 用户信息列表（已脱敏）
     */
    List<UserVO> getUserVOList(List<User> userList);

    /**
     * 获取查询条件
     *
     * @param userQueryRequest 用户查询请求
     * @return 查询字段
     */
    QueryWrapper<User> getQueryWrapper(UserQueryRequest userQueryRequest);

    /**
     * 是否为管理员
     *
     * @param user 用户
     * @return 是否为管理员
     */
    boolean isAdmin(User user);
}
